JavaScript中对光标和选区的操作

您所在的位置:网站首页 js 文本框 JavaScript中对光标和选区的操作

JavaScript中对光标和选区的操作

#JavaScript中对光标和选区的操作| 来源: 网络整理| 查看: 265

在一些业务场景,比如高亮文本、输入编辑、等场景中需要对光标和选区进行操作时,可以使用浏览器提供的 Selection 对象和 Range 对象来操作光标和选区。

Selection 对象

Selection 对象表示用户选择的选区或插入符号的当前位置,它可能横跨多个元素。

//获取 Selection 对象 window.getSelection(); 复制代码

用户可能从左到右(与文档方向相同)选择文本或从右到左(与文档方向相反)选择文本。

anchor (锚点): 指用户开始选择的地方。 focus (焦点): 指用户结束选择的地方。

如果你使用鼠标选择文本的话,anchor 就指你按下鼠标键的地方,而 focus 就指你松开鼠标键的地方。anchor 和 focus 的概念不能与选区的起始位置和终止位置混淆,因为 anchor 可能在 focus 的前面,也可能在 focus 的后面,这取决于你选择文本时鼠标移动的方向,也就是按下鼠标键和松开鼠标键的位置。

如下图所示:

属性:

anchorNode: 锚点(anchor)所在节点。

anchorOffset:

如果 anchorNode 是文本节点、注释节点,返回锚点(anchor)到该节点中第一个字的字符个数。

如果 anchorNode 是元素节点,返回锚点(anchor)之前的同级节点总数。

focusNode: 焦点(focus)所在节点。

focusOffset:

如果 focusNode 是文本节点、注释节点,返回焦点(focus)到该节点中的第一个字的字符个数。

如果 focusNode 是元素节点,返回焦点(focus)之前的同级节点总数。

isCollapsed: 表示选区的起始位置和终止位置是否重合的 Boolean 值,如果为 true,可以认为当前没有内容选中。

rangeCount: 选区中包含的 Range 对象数量。

type: 描述当前选区的类型,有以下三个值:

None: 当前没有选择。 Caret: 仅单击,但未选择,选区已折叠(即光标在字符之间,并未处于选中状态)。 Range: 选择的是一个范围。

注意: 以上所有属性都是只读属性。

方法: addRange(range)

向选区(Selection 对象)中添加一个区域( Range 对象)。

参数:

range: 一个区域对象

示例: 文本 复制代码 //添加一个选区 var text = document.querySelector("#text"); var selObj = window.getSelection(); var rangeObj = document.createRange(); rangeObj.selectNode(text); selObj.addRange(rangeObj); 复制代码 collapse(parentNode,offset)

收起当前选区到一个点。文档不会发生改变。

参数:

parentNode: 光标落在的目标节点 offset: 可选,在目标节点内的偏移量

示例: 文本 复制代码 //收起选区到一个点,光标落在一个可编辑元素上 var text = document.querySelector("#text") window.getSelection().collapse(text,0); 复制代码 collapseToEnd()

取消当前选区,并把光标定位在原选区的最末尾处。

参数:

示例: var selObj = window.getSelection(); selObj.collapseToEnd(); 复制代码 collapseToStart()

取消当前选区,并把光标定位在原选区的最开始处。

参数:

示例: var selObj = window.getSelection(); selObj.collapseToStart(); 复制代码 containsNode(aNode,aPartlyContained)

判断指定的节点是否包含在 Selection 对象中(即是否被选中)。

参数:

aNode: 用于判断是否包含在 Selection 对象中的节点。 aPartlyContained: 当此参数为 true 时,Selection 对象包含 aNode 的一部分或全部时,containsNode() 方法返回true。 当此参数为 false (默认值)时,只有 Selection 对象完全包含 aNode 时,containsNode() 方法才返回 true。

示例: 文本 复制代码 var text = document.querySelector("#text"); var selObj = window.getSelection(); var contains = selObj.containsNode(text); 复制代码 deleteFromDocument()

从 DOM 中删除选中的文档片段。

参数:

示例: var selObj = window.getSelection(); selObj.deleteFromDocument(); 复制代码 extend(node,offset)

移动选区的焦点(focus)到指定的点。选区的锚点(anchor)不会移动。选区将从锚点(anchor)开始到新的焦点(focus),不管方向。

参数:

node: 焦点(focus)会被移至此节点内。 offset: 可选,默认值为0,焦点(focus)会被移至 node 内的偏移位置。

示例: 文本 复制代码 var text = document.querySelector("#text"); var selObj = window.getSelection(); selObj.extend(text); 复制代码 getRangeAt(index)

返回一个当前选区包含的 Range 对象。

参数:

index: 该参数指定 Range 对象的索引。如果该数值大于或等于 rangeCount ,将会报错。

示例: //获取一个 Selection 对象 var selObj = window.getSelection(); //获取一个 Range 对象 var rangeObj = selObj.getRangeAt(0); 复制代码 modify(alter,direction,granularity)

通过文本命令来更改当前选区或光标位置。

参数:

alter:改变类型,传入 move 来移动光标位置,或者 extend 来扩展当前选区。 direction:调整选区的方向。你可以传入 forward 或 backward 来根据选区内容的语言书写方向来调整。或者使用 left 或 right 来指明一个明确的调整方向。 granularity:调整的距离颗粒度。可选值有 character、word、sentence、line、paragraph、lineboundary、sentenceboundary、paragraphboundary、documentboundary。

示例: var selection = window.getSelection(); selection.modify("extend", "forward", "word"); 复制代码 removeAllRanges()

会从当前 Selection 对象中移除所有的 Range 对象,取消所有的选择。

参数:

示例: var selObj = window.getSelection(); selObj.removeAllRanges(); 复制代码 removeRange(range)

将一个 Range 对象从选区中移除。

参数:

range: 一个将从选区中移除的 Range 对象。

示例: var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0) selObj.removeRange(rangeObj); 复制代码 selectAllChildren(parentNode)

把指定元素的所有子元素设置为选区(该元素本身除外),并取消之前的选区。

参数:

parentNode: 指定元素

示例: 文本1 文本2 复制代码 var selectAll = document.querySelector("#selectAll"); var selObj = window.getSelection(); selObj.selectAllChildren(selectAll); 复制代码 setBaseAndExtent(anchorNode,anchorOffset,focusNode,focusOffset)

选中两个特定 DOM 节点之间的内容。

参数:

anchorNode: 选中内容的开始节点 anchorOffset:选区起始位置在 anchorNode 内的偏移量。 如果 anchorNode 是文本节点,表示选区起始位置在该节点第几个字符位置。 如果 anchorNode 是元素节点,表示选区起始位置在该节点内第几个子节点的位置。 focusNode: 选中内容的结束节点 focusOffset: 选区终止位置在 focusNode 内的偏移量。 如果 focusNode 是文本节点,表示选区终止位置在该节点第几个字符位置。 如果 focusNode 是元素节点,表示选区终止位置在该节点内第几个子节点的位置。

示例: 复制代码 var start = document.querySelector("#start"); var end = document.querySelector("#end"); var selObj = window.getSelection(); selObj.setBaseAndExtent(start,0,end,0); 复制代码 toString()

返回代表当前 Selection 对象的字符串,例如当前选择的文本。

参数:

示例: var selObj = window.getSelection(); selObj.toString(); 复制代码 Range 对象

Range 对象表示被选中的文档片段。一个 Range 对象可能包含整个元素节点,也可能包含元素节点的一部分,例如文本节点的一部分文字。用户通常只能选择一个 Range 对象,但是有的时候用户也有可能选择多个 Range 对象(只有火狐浏览器可以选择多个 Range 对象)。

可以用 Document 对象的 Document.createRange 方法创建 Range,也可以用 Selection 对象的 getRangeAt 方法获取 Range。另外,还可以通过 Document 对象的构造函数 Range() 来得到 Range。

属性:

collapsed: 返回一个表示起始位置和终止位置是否相同的 Boolean 值。

commonAncestorContainer: 返回包含 startContainer 和 endContainer 的最深一级的节点。

endContainer: 返回包含 Range 终点位置的节点。

endOffset:

如果 endContainer 是文本节点、注释节点,返回该节点第一个字到选区边界的字符个数(即被选中的字符个数)。

如果 endContainer 是元素节点,返回选区终止位置之后第一个节点之前的同级节点总数。

startContainer: 返回包含 Range 开始位置的节点。

startOffset:

如果 startContainer 是文本节点、注释节点,返回该节点第一个字到选区边界的字符个数(即未被选中的字符个数)。

如果 startContainer 是元素节点,返回选区起始位置第一个节点之前的同级节点总数。

注意: 以上所有属性都是只读属性。

方法: cloneContents()

返回一个文档片段,它是 Range 对象中所有节点的副本。

参数:

示例: // 在文档中插入选中元素 var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); documentFragment = rangeObj.cloneContents(); document.body.appendChild(documentFragment); 复制代码 cloneRange()

返回一个 Range 对象的副本(两个对象各自做出改变,都不会影响另一方)。

参数:

示例: var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); clone = rangeObj.cloneRange(); 复制代码 collapse(toStart)

向开始或结束方向折叠 Range 。

参数:

toStart: 可选,Boolean 值(默认值 false), true 折叠到 Range 的开始方向,false 折叠到结束方向。

示例: var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); rangeObj.collapse(true); 复制代码 compareBoundaryPoints(how, sourceRange)

比较两个 Range 对象的起始位置节点或结束位置节点。

参数:

how 表示比较方法的常量:

Range.END_TO_END :比较 sourceRange 对象的结束位置节点和原 Range 对象的结束位置节点。 复制代码 Range.END_TO_START :比较 sourceRange 对象的结束位置节点和原 Range 对象的起始位置节点。 Range.START_TO_END :比较 sourceRange 对象的起始位置节点和原 Range 对象的结束位置节点。 Range.START_TO_START :比较 sourceRange 对象的起始位置节点和原 Range 对象的起始位置节点。 复制代码

sourceRange: 一个与原 Range 对象比较的 Range 对象。

返回值

compare 表示一个数字:

-1 :原 Range 对象的比较节点在 sourceRange 对象的比较节点之前 复制代码 0 :原 Range 对象的比较节点在 sourceRange 对象的比较节点的相同位置 1 :原 Range 对象的比较节点在 sourceRange 对象的比较节点之后 复制代码 示例: range sourceRange 复制代码 var range, sourceRange, compare; range = document.createRange(); range.selectNode(document.querySelector("#rang")); sourceRange = document.createRange(); sourceRange.selectNode(document.querySelector("#sourceRange")); compare = range.compareBoundaryPoints(Range.START_TO_END, sourceRange); 复制代码 comparePoint(referenceNode,offset)

判断指定节点是在 Range 对象的之前、相同还是之后位置。

参数:

referenceNode: 与 Range 对象进行比较的节点。 offset: 在 referenceNode 内的偏移量。 如果 referenceNode 是文本节点、注释节点,offset 表示在该节点中字符的偏移位置。 如果 referenceNode 是元素节点,offset 表示在该节点中子元素的偏移位置。

示例: range referenceNode 复制代码 range = document.createRange(); range.selectNode(document.querySelector("#range")); returnValue = range.comparePoint(document.querySelector("#referenceNode"), 0); 复制代码 createContextualFragment(tagString)

将 HTML 字符串转换为文档片段

参数:

tagString: 要转换的 HTML 字符串。

示例: var tagString = "node"; var range = document.createRange(); var documentFragment = range.createContextualFragment(tagString); document.body.appendChild(documentFragment); 复制代码 deleteContents()

从 DOM 中删除选中的文档片段,不返回删除的文档片段。

参数:

示例: var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); rangeObj.deleteContents(); 复制代码 extractContents()

从 DOM 中删除选中的文档片段,返回删除的文档片段(不保留 DOM 事件)。

参数:

示例: var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); rangeObj.extractContents(); 复制代码 getBoundingClientRect()

返回一个 DOMRect 对象,表示整个选区的位置信息。

参数:

示例: var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); var boundingRect = rangeObj.getBoundingClientRect(); 复制代码 getClientRects()

返回一个选区内所有元素调用 Element.getClientRects() 方法所得结果的列表。表示选区在屏幕上所占的区域。

参数:

示例: var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); var boundingRect = rangeObj.getClientRects(); 复制代码 insertNode(newNode)

在选区开始处插入一个节点。

参数:

newNode: 需要插入的节点

示例: insertNode node 复制代码 range = document.createRange(); newNode = document.querySelector("#node"); range.selectNode(document.querySelector("#insertNode")); range.insertNode(newNode); 复制代码 intersectsNode(referenceNode)

返回一个 Boolean 值,判断指定节点和 Range 对象是否相交。

参数:

referenceNode:需要比较的节点

示例: referenceNode 复制代码 var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); referenceNode = document.querySelector("#referenceNode"); rangeObj.intersectsNode(referenceNode); 复制代码 isPointInRange(referenceNode,offset)

返回一个 Boolean 值,判断指定节点是否在 Range 对象内。

参数:

referenceNode:指定节点 offset:在 referenceNode 内的偏移量。 如果 referenceNode 是文本节点,offset 表示在该节点中字符的偏移位置。 如果 referenceNode 是元素节点,offset 表示在该节点中子元素的偏移位置。

示例: referenceNode 复制代码 var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); referenceNode = document.querySelector("#referenceNode"); rangeObj.isPointInRange(referenceNode,0); 复制代码 selectNode(referenceNode)

将指定节点包含在 Range 对象内。

参数:

referenceNode:指定节点

示例: referenceNode 复制代码 var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); referenceNode = document.querySelector("#referenceNode"); rangeObj.selectNode(referenceNode); 复制代码 selectNodeContents(referenceNode)

将指定节点的内容包含在 Range 对象内。

参数:

referenceNode:指定节点

示例: referenceNode 复制代码 var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); referenceNode = document.querySelector("#referenceNode"); rangeObj.selectNodeContents(referenceNode); 复制代码 setEnd(endNode,endOffset)

设置选区的终止位置。

参数:

endNode:终止位置所在的节点 endOffset:在 endNode 内的偏移量。 如果 endNode 是文本节点、注释节点,endOffset 表示在该节点中字符的偏移位置。 如果 endNode 是元素节点,endOffset 表示在该节点中子元素的偏移位置。

示例: endNode 复制代码 var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); var endNode = document.querySelector("#endNode"); rangeObj.setEnd(endNode,0) 复制代码 setEndAfter(referenceNode)

设置选区的结束位置在指定节点之后。

参数:

referenceNode:指定节点

示例: referenceNode 复制代码 var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); var referenceNode = document.querySelector("#referenceNode"); rangeObj.setEndAfter(referenceNode) 复制代码 setEndBefore(referenceNode)

设置选区的结束位置在指定节点之前。

参数:

referenceNode:指定节点

示例: referenceNode 复制代码 var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); var referenceNode = document.querySelector("#referenceNode"); rangeObj.setEndBefore(referenceNode) 复制代码 setStart(startNode,startOffset)

设置选区的起始位置。

参数:

startNode:起始位置所在的节点 startOffset:在 startNode 内的偏移量。 如果 startNode 是文本节点、注释节点,startOffset 表示在该节点中字符的偏移位置。 如果 startNode 是元素节点,startOffset 表示在该节点中子元素的偏移位置。

示例: startNode 复制代码 var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); startNode = document.querySelector("#startNode"); rangeObj.setStart(startNode,0) 复制代码 setStartAfter(referenceNode)

设置选区的起始位置在指定节点之后。

参数:

referenceNode:指定节点

示例: referenceNode 复制代码 var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); referenceNode = document.querySelector("#referenceNode"); rangeObj.setStartAfter(referenceNode) 复制代码 setStartBefore(referenceNode)

设置选区的起始位置在指定节点之前。

参数:

referenceNode:指定节点

示例: referenceNode 复制代码 var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); referenceNode = document.querySelector("#referenceNode"); rangeObj.setStartBefore(referenceNode) 复制代码 surroundContents(newParent)

把指定节点插入选区的起始位置,然后把指定节点的内容替换为选区的内容。

参数:

newParent:指定节点

示例: newParent 复制代码 var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); newParent = document.querySelector("#newParent"); rangeObj.surroundContents(newParent) 复制代码 toString()

返回代表当前 Range 对象的字符串,例如当前选择的文本。

参数:

示例: var selObj = window.getSelection(); var rangeObj = selObj.getRangeAt(0); var rangeStr = rangeObj.toString(); 复制代码 选区中的多个区域

一个 Selection 对象表示用户选择的区域(Range 对象)的集合,通常它只包含一个区域,访问方式如下:

//获取一个 Selection 对象 var selObj = window.getSelection(); //获取一个 Range 对象 var rangeObj = selObj.getRangeAt(0); 复制代码

只有火狐浏览器实现了多个区域,如下图所示:

多个区域

修改选区样式

使用 ::selection 选择器可以匹配被选中的部分。 目前只有一小部分 CSS 属性可以用于 ::selection 选择器:

color background-color text-shadow 示例

示例地址

参考

Selection

Range

笔记 Javascript的Selection对象:基本属性

利用 javascript 实现富文本编辑器

What is anchorNode , baseNode , extentNode and focusNode in the object returned by document.getSelection?

Coordinates of selected text in browser page



【本文地址】


今日新闻


推荐新闻


CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3